Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Conversation

@nastra
Copy link
Contributor

@nastra nastra commented Jun 3, 2022

No description provided.

@nastra nastra force-pushed the release-docs-preparation-improvements branch from 002819c to 186a416 Compare June 3, 2022 12:47
Copy link
Contributor

@samredai samredai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small grammar nits but overall LGTM, Thank you @nastra!

@nastra nastra force-pushed the release-docs-preparation-improvements branch from 186a416 to c5a5b73 Compare June 3, 2022 14:18
4. Update the latest artifact links in the release notes page in `landing-page/content/common/release-notes.md`
5. Add release notes for the new release version in `landing-page/content/common/release-notes.md`

#### Documentation update
Copy link
Contributor

@samredai samredai Jun 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's not part of this PR but I'm noticing that these instructions should actually come after the Cutting a new version branch section. These changes should then occur on that versioned branch. Here's the sequence that I think should be reflected here:

  • Clone your fork of apache/iceberg

  • Clone your fork of apache/iceberg-docs

  • Run cp -r iceberg/format/* iceberg-docs/landing-page/content/common/

  • cd into the iceberg-docs directory

  • Create an update-common-pages branch

  • Commit, Push, and Open a PR against apache/iceberg-docs (update-common-pages -> main)

  • Create a branch from main that's named after the version (i.e. 0.13.2). This must be done in the main repo, not in your fork.

  • Fetch and checkout the version branch: i.e. git fetch && git checkout 0.13.2

  • Copy the versioned docs in using cp -r ../iceberg/docs ../iceberg-docs/docs/content/docs

  • Change into the iceberg directory and generate the javadoc cd ../iceberg && ./gradlew refreshJavadoc

  • Copy the javadoc into the apache/iceberg-docs repo: cp -r site/docs/javadoc/<VERSION NUMBER> ../iceberg-docs/javadoc

  • Change into the iceberg-docs directory, Commit, Push and Open a PR against the 0.13.2 branch in apache/iceberg-docs

  • Checkout the main branch in apache/iceberg-docs

  • Create a branch move-forward-latest-version

  • Update variable latestVersions.iceberg to the new release version in landing-page/config.toml

  • Update variable latestVersions.iceberg to the new release version in docs/config.toml

  • Mark the current latest release notes to past releases under landing-page/content/common/release-notes.md

  • Update the latest artifact links in the release notes page in landing-page/content/common/release-notes.md

  • Add release notes for the new release version in landing-page/content/common/release-notes.md

  • Commit, Push, and Open a PR against apache/iceberg-docs (move-forward-latest-version -> main)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nastra I've opened a PR against your fork to update this to represent the flow listed above. Please take a look when you have a chance and let me know what you think.

The general ordering requires that the common pages are updated and merged and then a version branch has to be cut immediately. Everything after that (adding versioned docs & adding javadocs), then happens against that version branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @samredai, approved and merged it

@nastra nastra force-pushed the release-docs-preparation-improvements branch from bbfdd54 to a49da78 Compare June 13, 2022 15:03
@nastra nastra force-pushed the release-docs-preparation-improvements branch from a49da78 to 4ea18e8 Compare June 13, 2022 15:05
@RussellSpitzer RussellSpitzer merged commit 3c3d40d into apache:main Jun 15, 2022
@nastra nastra deleted the release-docs-preparation-improvements branch June 15, 2022 13:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants